Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cookiecutter template #306

Closed
wants to merge 2 commits into from
Closed

Conversation

kaitj
Copy link
Contributor

@kaitj kaitj commented Jun 9, 2023

Proposed changes

Was playing around a bit more with cookiecutter and decided to do a little bit of maintenance for the snakebids cookiecutter, though I may have missed a few things. Some changes include:

  • Update .rst to .md
  • Cleanup the cookiecutter.json to take advantage of private rendered variables (mainly for {{ cookiecutter.app_name }} so that the user isn't asked for both app_full_name and app_name).
  • Moved setup.py to pyproject.toml

I had to ignore the project_template folder from the linting, which I don't really want to do. The jinja syntax in the pyproject.toml there is conflicting with the ruff linter and I couldn't get it to work excluding the single pyproject.toml file. If anyone has any ideas, I'd be open to it.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

Notes

All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

@kaitj kaitj added the maintenance Updates or improvements that do not change functionality of the code label Jun 9, 2023
@kaitj kaitj force-pushed the maint/cookiecutter branch 2 times, most recently from 005841c to 0a4bb99 Compare June 10, 2023 17:26
- change .rst files to .md
- update cookiecutter variables
  - app_name changed to private rendered variable
  - constants like version numbers set to private unrendered variables
- change setup.py to pyproject.toml
- updated pipeline_description.json to be more human readible
Already removed from cookiecutter. May need a separate way to specify where the project ends up.
@kaitj kaitj marked this pull request as draft June 12, 2023 21:40
@kaitj
Copy link
Contributor Author

kaitj commented Jun 24, 2023

Going to close this to reorganize this PR and potentially include #307 and/or #313.

@kaitj kaitj closed this Jun 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Updates or improvements that do not change functionality of the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant